<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>collation.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="local_closure_goog_i18n_collation.js.html">collation.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2013 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>
<a name="line16"></a>/**
<a name="line17"></a> * @fileoverview Contains helper functions for performing locale-sensitive
<a name="line18"></a> *     collation.
<a name="line19"></a> */
<a name="line20"></a>
<a name="line21"></a>
<a name="line22"></a>goog.provide(&#39;goog.i18n.collation&#39;);
<a name="line23"></a>
<a name="line24"></a>
<a name="line25"></a>/**
<a name="line26"></a> * Returns the comparator for a locale. If a locale is not explicitly specified,
<a name="line27"></a> * a comparator for the user&#39;s locale will be returned. Note that if the browser
<a name="line28"></a> * does not support locale-sensitive string comparisons, the comparator returned
<a name="line29"></a> * will be a simple codepoint comparator.
<a name="line30"></a> *
<a name="line31"></a> * @param {string=} opt_locale the locale that the comparator is used for.
<a name="line32"></a> * @return {function(string, string): number} The locale-specific comparator.
<a name="line33"></a> */
<a name="line34"></a>goog.i18n.collation.createComparator = function(opt_locale) {
<a name="line35"></a>  // See http://code.google.com/p/v8-i18n.
<a name="line36"></a>  if (goog.i18n.collation.hasNativeComparator()) {
<a name="line37"></a>    var intl = goog.global.Intl;
<a name="line38"></a>    return new intl.Collator([opt_locale || goog.LOCALE]).compare;
<a name="line39"></a>  } else {
<a name="line40"></a>    return function(arg1, arg2) {
<a name="line41"></a>      return arg1.localeCompare(arg2);
<a name="line42"></a>    };
<a name="line43"></a>  }
<a name="line44"></a>};
<a name="line45"></a>
<a name="line46"></a>
<a name="line47"></a>/**
<a name="line48"></a> * Returns true if a locale-sensitive comparator is available for a locale. If
<a name="line49"></a> * a locale is not explicitly specified, the user&#39;s locale is used instead.
<a name="line50"></a> *
<a name="line51"></a> * @param {string=} opt_locale The locale to be checked.
<a name="line52"></a> * @return {boolean} Whether there is a locale-sensitive comparator available
<a name="line53"></a> *     for the locale.
<a name="line54"></a> */
<a name="line55"></a>goog.i18n.collation.hasNativeComparator = function(opt_locale) {
<a name="line56"></a>  var intl = goog.global.Intl;
<a name="line57"></a>  return !!(intl &amp;&amp; intl.Collator);
<a name="line58"></a>};
</pre>


</body>
</html>
